package com.xuelang.pipeline.artifact.client.common.validator;

import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义注解，用于验证枚举类型的字段是否合法。
 *
 * @author xiwen.zxg
 * @since 2024/6/27
 */
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = EnumValidator.class)
public @interface ValidEnum {

    /**
     * 指定要验证的枚举类。
     * @return 枚举类的类型
     */
    Class<? extends Enum<?>> enumClass();

    /**
     * 错误消息，默认为 "Invalid enum value"。
     * @return 错误消息字符串
     */
    String message() default "Invalid enum value";

    /**
     * 分组，用于分组验证。
     * @return 分组数组
     */
    Class<?>[] groups() default {};

    /**
     * 附加负载，用于传递额外信息到验证器。
     * @return 负载数组
     */
    Class<? extends Payload>[] payload() default {};
}
